
<!doctype html>
<html lang="zh" class="no-js">
  <head>
    
      <meta charset="utf-8">
      <meta name="viewport" content="width=device-width,initial-scale=1">
      
      
      
      
      <link rel="icon" href="../../assets/images/favicon.png">
      <meta name="generator" content="mkdocs-1.2.3, mkdocs-material-7.3.6">
    
    
      
        <title>参数化数据驱动 - HttpRunner V3.x中文文档</title>
      
    
    
      <link rel="stylesheet" href="../../assets/stylesheets/main.a57b2b03.min.css">
      
        
        <link rel="stylesheet" href="../../assets/stylesheets/palette.3f5d1f46.min.css">
        
      
    
    
    
      
        
        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
        <style>:root{--md-text-font-family:"Roboto";--md-code-font-family:"Roboto Mono"}</style>
      
    
    
    
    
      


    
    
  </head>
  
  
    
    
    
    
    
    <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
  
    
    <script>function __prefix(e){return new URL("../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
    
    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
    <label class="md-overlay" for="__drawer"></label>
    <div data-md-component="skip">
      
        
        <a href="#_1" class="md-skip">
          跳转至
        </a>
      
    </div>
    <div data-md-component="announce">
      
    </div>
    
      

<header class="md-header" data-md-component="header">
  <nav class="md-header__inner md-grid" aria-label="Header">
    <a href="../.." title="HttpRunner V3.x中文文档" class="md-header__button md-logo" aria-label="HttpRunner V3.x中文文档" data-md-component="logo">
      
  
  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>

    </a>
    <label class="md-header__button md-icon" for="__drawer">
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
    </label>
    <div class="md-header__title" data-md-component="header-title">
      <div class="md-header__ellipsis">
        <div class="md-header__topic">
          <span class="md-ellipsis">
            HttpRunner V3.x中文文档
          </span>
        </div>
        <div class="md-header__topic" data-md-component="header-topic">
          <span class="md-ellipsis">
            
              参数化数据驱动
            
          </span>
        </div>
      </div>
    </div>
    
    
    
      <label class="md-header__button md-icon" for="__search">
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
      </label>
      
<div class="md-search" data-md-component="search" role="dialog">
  <label class="md-search__overlay" for="__search"></label>
  <div class="md-search__inner" role="search">
    <form class="md-search__form" name="search">
      <input type="text" class="md-search__input" name="query" aria-label="搜索" placeholder="搜索" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
      <label class="md-search__icon md-icon" for="__search">
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
      </label>
      <nav class="md-search__options" aria-label="Search">
        
        <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
        </button>
      </nav>
      
    </form>
    <div class="md-search__output">
      <div class="md-search__scrollwrap" data-md-scrollfix>
        <div class="md-search-result" data-md-component="search-result">
          <div class="md-search-result__meta">
            正在初始化搜索引擎
          </div>
          <ol class="md-search-result__list"></ol>
        </div>
      </div>
    </div>
  </div>
</div>
    
    
  </nav>
  
</header>
    
    <div class="md-container" data-md-component="container">
      
      
        
          
        
      
      <main class="md-main" data-md-component="main">
        <div class="md-main__inner md-grid">
          
            
              
              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
                <div class="md-sidebar__scrollwrap">
                  <div class="md-sidebar__inner">
                    


<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  <label class="md-nav__title" for="__drawer">
    <a href="../.." title="HttpRunner V3.x中文文档" class="md-nav__button md-logo" aria-label="HttpRunner V3.x中文文档" data-md-component="logo">
      
  
  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>

    </a>
    HttpRunner V3.x中文文档
  </label>
  
  <ul class="md-nav__list" data-md-scrollfix>
    
      
      
      

  
  
  
    <li class="md-nav__item">
      <a href="../.." class="md-nav__link">
        名词解释
      </a>
    </li>
  

    
      
      
      

  
  
  
    <li class="md-nav__item">
      <a href="../../10-HttpRunner%E7%AE%80%E4%BB%8B/" class="md-nav__link">
        简介
      </a>
    </li>
  

    
      
      
      

  
  
  
    <li class="md-nav__item">
      <a href="../../20-HttpRunner%E5%AE%89%E8%A3%85/" class="md-nav__link">
        安装
      </a>
    </li>
  

    
      
      
      

  
  
  
    
    <li class="md-nav__item md-nav__item--nested">
      
      
        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
      
      
      
      
        <label class="md-nav__link" for="__nav_4">
          用户指南
          <span class="md-nav__icon md-icon"></span>
        </label>
      
      <nav class="md-nav" aria-label="用户指南" data-md-level="1">
        <label class="md-nav__title" for="__nav_4">
          <span class="md-nav__icon md-icon"></span>
          用户指南
        </label>
        <ul class="md-nav__list" data-md-scrollfix>
          
            
              
  
  
  
    <li class="md-nav__item">
      <a href="../../%E7%94%A8%E6%88%B7%E6%8C%87%E5%8D%97/31-%E6%A6%82%E8%BF%B0/" class="md-nav__link">
        HttpRunner概念
      </a>
    </li>
  

            
          
            
              
  
  
  
    <li class="md-nav__item">
      <a href="../../%E7%94%A8%E6%88%B7%E6%8C%87%E5%8D%97/32-%E5%BF%AB%E9%80%9F%E4%B8%8A%E6%89%8B/" class="md-nav__link">
        快速上手
      </a>
    </li>
  

            
          
            
              
  
  
  
    <li class="md-nav__item">
      <a href="../../%E7%94%A8%E6%88%B7%E6%8C%87%E5%8D%97/33-%E5%BD%95%E5%88%B6%E5%B9%B6%E7%94%9F%E6%88%90%E6%B5%8B%E8%AF%95%E6%8A%A5%E5%91%8A/" class="md-nav__link">
        录制并生成测试用例
      </a>
    </li>
  

            
          
            
              
  
  
  
    <li class="md-nav__item">
      <a href="../../%E7%94%A8%E6%88%B7%E6%8C%87%E5%8D%97/34-%E7%BC%96%E5%86%99%E6%B5%8B%E8%AF%95%E7%94%A8%E4%BE%8B/" class="md-nav__link">
        编写测试用例
      </a>
    </li>
  

            
          
            
              
  
  
  
    <li class="md-nav__item">
      <a href="../../%E7%94%A8%E6%88%B7%E6%8C%87%E5%8D%97/35-%E8%BF%90%E8%A1%8C%E6%B5%8B%E8%AF%95%E7%94%A8%E4%BE%8B/" class="md-nav__link">
        运行测试用例
      </a>
    </li>
  

            
          
            
              
  
  
  
    <li class="md-nav__item">
      <a href="../../%E7%94%A8%E6%88%B7%E6%8C%87%E5%8D%97/36-%E6%B5%8B%E8%AF%95%E6%8A%A5%E5%91%8A/" class="md-nav__link">
        测试报告
      </a>
    </li>
  

            
          
            
              
  
  
  
    <li class="md-nav__item">
      <a href="../../%E7%94%A8%E6%88%B7%E6%8C%87%E5%8D%97/37-%E8%BF%90%E8%A1%8C%E8%B4%9F%E8%BD%BD%E6%B5%8B%E8%AF%95/" class="md-nav__link">
        运行负载测试
      </a>
    </li>
  

            
          
            
              
  
  
  
    <li class="md-nav__item">
      <a href="../../%E7%94%A8%E6%88%B7%E6%8C%87%E5%8D%97/39-%E5%8F%91%E5%B8%83%E5%8E%86%E5%8F%B2/" class="md-nav__link">
        发布历史
      </a>
    </li>
  

            
          
        </ul>
      </nav>
    </li>
  

    
      
      
      

  
  
    
  
  
    
    <li class="md-nav__item md-nav__item--active md-nav__item--nested">
      
      
        <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
      
      
      
      
        <label class="md-nav__link" for="__nav_5">
          补充
          <span class="md-nav__icon md-icon"></span>
        </label>
      
      <nav class="md-nav" aria-label="补充" data-md-level="1">
        <label class="md-nav__title" for="__nav_5">
          <span class="md-nav__icon md-icon"></span>
          补充
        </label>
        <ul class="md-nav__list" data-md-scrollfix>
          
            
              
  
  
  
    <li class="md-nav__item">
      <a href="../10-%E9%A1%B9%E7%9B%AE%E6%96%87%E4%BB%B6%E7%BB%84%E7%BB%87/" class="md-nav__link">
        项目文件组织
      </a>
    </li>
  

            
          
            
              
  
  
  
    <li class="md-nav__item">
      <a href="../20-%E6%B5%8B%E8%AF%95%E7%94%A8%E4%BE%8B%E7%BB%84%E7%BB%87/" class="md-nav__link">
        测试用例组织
      </a>
    </li>
  

            
          
            
              
  
  
  
    <li class="md-nav__item">
      <a href="../30-Hook%E6%9C%BA%E5%88%B6/" class="md-nav__link">
        Hook机制
      </a>
    </li>
  

            
          
            
              
  
  
  
    <li class="md-nav__item">
      <a href="../40-%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F/" class="md-nav__link">
        环境变量
      </a>
    </li>
  

            
          
            
              
  
  
  
    <li class="md-nav__item">
      <a href="../50-%E6%B5%8B%E8%AF%95%E7%94%A8%E4%BE%8B%E5%88%86%E5%B1%82/" class="md-nav__link">
        测试用例分层
      </a>
    </li>
  

            
          
            
              
  
  
    
  
  
    <li class="md-nav__item md-nav__item--active">
      
      <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
      
      
        
      
      
        <label class="md-nav__link md-nav__link--active" for="__toc">
          参数化数据驱动
          <span class="md-nav__icon md-icon"></span>
        </label>
      
      <a href="./" class="md-nav__link md-nav__link--active">
        参数化数据驱动
      </a>
      
        


<nav class="md-nav md-nav--secondary" aria-label="目录">
  
  
  
    
  
  
    <label class="md-nav__title" for="__toc">
      <span class="md-nav__icon md-icon"></span>
      目录
    </label>
    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
      
        <li class="md-nav__item">
  <a href="#_2" class="md-nav__link">
    介绍
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#testsuite" class="md-nav__link">
    测试用例集（testsuite）准备
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#_3" class="md-nav__link">
    参数配置概述
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#_4" class="md-nav__link">
    参数配置详解
  </a>
  
    <nav class="md-nav" aria-label="参数配置详解">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#_5" class="md-nav__link">
    独立参数 &amp; 直接指定参数列表
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#_6" class="md-nav__link">
    关联参数 &amp; 直接指定参数列表
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#csv" class="md-nav__link">
    独立参数 &amp; 引用 CSV 文件
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#csv_1" class="md-nav__link">
    关联参数 &amp; 引用 CSV 文件
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#_7" class="md-nav__link">
    独立参数 &amp; 引用自定义函数
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#_8" class="md-nav__link">
    关联参数 &amp; 引用自定义函数
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#_9" class="md-nav__link">
    参数化运行
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#_10" class="md-nav__link">
    案例演示
  </a>
  
</li>
      
    </ul>
  
</nav>
      
    </li>
  

            
          
            
              
  
  
  
    <li class="md-nav__item">
      <a href="../70-%E6%96%87%E4%BB%B6%E4%B8%8A%E4%BC%A0%E5%9C%BA%E6%99%AF/" class="md-nav__link">
        文件上传场景
      </a>
    </li>
  

            
          
        </ul>
      </nav>
    </li>
  

    
  </ul>
</nav>
                  </div>
                </div>
              </div>
            
            
              
              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
                <div class="md-sidebar__scrollwrap">
                  <div class="md-sidebar__inner">
                    


<nav class="md-nav md-nav--secondary" aria-label="目录">
  
  
  
    
  
  
    <label class="md-nav__title" for="__toc">
      <span class="md-nav__icon md-icon"></span>
      目录
    </label>
    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
      
        <li class="md-nav__item">
  <a href="#_2" class="md-nav__link">
    介绍
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#testsuite" class="md-nav__link">
    测试用例集（testsuite）准备
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#_3" class="md-nav__link">
    参数配置概述
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#_4" class="md-nav__link">
    参数配置详解
  </a>
  
    <nav class="md-nav" aria-label="参数配置详解">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#_5" class="md-nav__link">
    独立参数 &amp; 直接指定参数列表
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#_6" class="md-nav__link">
    关联参数 &amp; 直接指定参数列表
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#csv" class="md-nav__link">
    独立参数 &amp; 引用 CSV 文件
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#csv_1" class="md-nav__link">
    关联参数 &amp; 引用 CSV 文件
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#_7" class="md-nav__link">
    独立参数 &amp; 引用自定义函数
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#_8" class="md-nav__link">
    关联参数 &amp; 引用自定义函数
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#_9" class="md-nav__link">
    参数化运行
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#_10" class="md-nav__link">
    案例演示
  </a>
  
</li>
      
    </ul>
  
</nav>
                  </div>
                </div>
              </div>
            
          
          <div class="md-content" data-md-component="content">
            <article class="md-content__inner md-typeset">
              
                
                
                <h1 id="_1">参数化数据驱动</h1>
<h2 id="_2">介绍</h2>
<p>在自动化测试中，经常会遇到如下场景：</p>
<ul>
<li>测试搜索功能，只有一个搜索输入框，但有 10 种不同类型的搜索关键字；</li>
<li>测试账号登录功能，需要输入用户名和密码，按照等价类划分后有 20 种组合情况。</li>
</ul>
<p>这里只是随意找了两个典型的例子，相信大家都有遇到过很多类似的场景。总结下来，就是在我们的自动化测试脚本中存在参数，并且我们需要采用不同的参数去运行。</p>
<p>经过概括，参数基本上分为两种类型：</p>
<ul>
<li>单个独立参数：例如前面的第一种场景，我们只需要变换搜索关键字这一个参数</li>
<li>多个具有关联性的参数：例如前面的第二种场景，我们需要变换用户名和密码两个参数，并且这两个参数需要关联组合</li>
</ul>
<p>然后，对于参数而言，我们可能具有一个参数列表，在脚本运行时需要按照不同的规则去取值，例如顺序取值、随机取值、循环取值等等。</p>
<p>这就是典型的参数化和数据驱动。</p>
<p>如需了解 HttpRunner 参数化数据驱动机制的实现原理和技术细节，可前往阅读<a href="http://debugtalk.com/post/httprunner-data-driven/">《HttpRunner 实现参数化数据驱动机制》</a>。</p>
<h2 id="testsuite">测试用例集（testsuite）准备</h2>
<p>从 2.0.0 版本开始，HttpRunner 不再支持在测试用例文件中进行参数化配置；参数化的功能需要在 testsuite 中实现。变更的目的是让测试用例（testcase）的概念更纯粹，关于测试用例和测试用例集的概念定义，详见<a href="https://v2.httprunner.org/prepare/parameters/">《测试用例组织》</a>。</p>
<p>参数化机制需要在测试用例集（testsuite）中实现。如需实现数据驱动机制，需要创建一个 testsuite，在 testsuite 中引用测试用例，并定义参数化配置。</p>
<p>测试用例集（testsuite）的格式如下所示：</p>
<pre><code class="language-yaml">config:
    name: testsuite description

testcases:
    testcase1_name:
        testcase: /path/to/testcase1

    testcase2_name:
        testcase: /path/to/testcase2
</code></pre>
<p>需要注意的是，testsuite 和 testcase 的格式存在较大区别，详见<a href="https://v2.httprunner.org/prepare/testcase-structure/">《测试用例组织》</a>。</p>
<h2 id="_3">参数配置概述</h2>
<p>如需对某测试用例（testcase）实现参数化数据驱动，需要使用 <code>parameters</code> 关键字，定义参数名称并指定数据源取值方式。</p>
<p>参数名称的定义分为两种情况：</p>
<ul>
<li>独立参数单独进行定义；</li>
<li>多个参数具有关联性的参数需要将其定义在一起，采用短横线（<code>-</code>）进行连接。</li>
</ul>
<p>数据源指定支持三种方式：</p>
<ul>
<li>在 YAML/JSON 中直接指定参数列表：该种方式最为简单易用，适合参数列表比较小的情况</li>
<li>通过内置的 parameterize（可简写为P）函数引用 CSV 文件：该种方式需要准备 CSV 数据文件，适合数据量比较大的情况</li>
<li>调用 debugtalk.py 中自定义的函数生成参数列表：该种方式最为灵活，可通过自定义 Python 函数实现任意场景的数据驱动机制，当需要动态生成参数列表时也需要选择该种方式</li>
</ul>
<p>三种方式可根据实际项目需求进行灵活选择，同时支持多种方式的组合使用。假如测试用例中定义了多个参数，那么测试用例在运行时会对参数进行笛卡尔积组合，覆盖所有参数组合情况。</p>
<p>使用方式概览如下：</p>
<pre><code class="language-yaml">config:
    name: &quot;demo&quot;

testcases:
    testcase1_name:
        testcase: /path/to/testcase1
        parameters:
            user_agent: [&quot;iOS/10.1&quot;, &quot;iOS/10.2&quot;, &quot;iOS/10.3&quot;]
            user_id: ${P(user_id.csv)}
            username-password: ${get_account(10)}
</code></pre>
<h2 id="_4">参数配置详解</h2>
<p>将参数名称定义和数据源指定方式进行组合，共有 6 种形式。现分别针对每一类情况进行详细说明。</p>
<h3 id="_5">独立参数 &amp; 直接指定参数列表</h3>
<p>对于参数列表比较小的情况，最简单的方式是直接在 YAML/JSON 中指定参数列表内容。</p>
<p>例如，对于独立参数 <code>user_id</code>，参数列表为 <code>[1001, 1002, 1003, 1004]</code>，那么就可以按照如下方式进行配置：</p>
<pre><code>config:
    name: testcase description

testcases:
    create user:
        testcase: demo-quickstart-6.yml
        parameters:
            user_id: [1001, 1002, 1003, 1004]
</code></pre>
<p>进行该配置后，测试用例在运行时就会对 user_id 实现数据驱动，即分别使用 <code>[1001, 1002, 1003, 1004]</code> 四个值运行测试用例。</p>
<details style="box-sizing: inherit; margin: 1.5625em 0px; padding: 0px 0.6rem; overflow: visible; color: rgba(0, 0, 0, 0.87); font-size: 0.64rem; break-inside: avoid; background-color: var(--md-admonition-bg-color); border-left: 0.2rem solid rgb(68, 138, 255); border-radius: 0.1rem; box-shadow: rgba(0, 0, 0, 0.05) 0px 0.2rem 0.5rem, rgba(0, 0, 0, 0.1) 0px 0px 0.05rem; display: block; font-family: Roboto, -apple-system, BlinkMacSystemFont, Helvetica, Arial, sans-serif; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><summary style="box-sizing: inherit; position: relative; margin: 0px -0.6rem; padding: 0.4rem 1.8rem 0.4rem 2rem; font-weight: 700; background-color: rgba(68, 138, 255, 0.1); display: block; min-height: 1rem; border-top-right-radius: 0.1rem; cursor: pointer; border-bottom-right-radius: 0.1rem;">点击查看运行日志</summary></details>

<p>可以看出，测试用例总共运行了 4 次，并且每次运行时都是采用的不同 user_id。</p>
<h3 id="_6">关联参数 &amp; 直接指定参数列表</h3>
<p>对于具有关联性的多个参数，例如 username 和 password，那么就可以按照如下方式进行配置：</p>
<pre><code>config:
    name: &quot;demo&quot;

testcases:
    testcase1_name:
        testcase: /path/to/testcase1
        parameters:
            username-password:
                - [&quot;user1&quot;, &quot;111111&quot;]
                - [&quot;user2&quot;, &quot;222222&quot;]
                - [&quot;user3&quot;, &quot;333333&quot;]
</code></pre>
<p>进行该配置后，测试用例在运行时就会对 username 和 password 实现数据驱动，即分别使用 <code>{"username": "user1", "password": "111111"}</code>、<code>{"username": "user2", "password": "222222"}</code>、<code>{"username": "user3", "password": "333333"}</code> 运行 3 次测试，并且保证参数值总是成对使用。</p>
<h3 id="csv">独立参数 &amp; 引用 CSV 文件</h3>
<p>对于已有参数列表，并且数据量比较大的情况，比较适合的方式是将参数列表值存储在 CSV 数据文件中。</p>
<p>对于 CSV 数据文件，需要遵循如下几项约定的规则：</p>
<ul>
<li>CSV 文件中的第一行必须为参数名称，从第二行开始为参数值，每个（组）值占一行；</li>
<li>若同一个 CSV 文件中具有多个参数，则参数名称和数值的间隔符需实用英文逗号；</li>
<li>在 YAML/JSON 文件引用 CSV 文件时，文件路径为基于项目根目录（debugtalk.py 所在路径）的相对路径。</li>
</ul>
<p>例如，user_id 的参数取值范围为 1001～2000，那么我们就可以创建 user_id.csv，并且在文件中按照如下形式进行描述。</p>
<pre><code>user_id
1001
1002
...
1999
2000
</code></pre>
<p>然后在 YAML/JSON 测试用例文件中，就可以通过内置的 <code>parameterize</code>（可简写为 <code>P</code>）函数引用 CSV 文件。</p>
<p>假设项目的根目录下有 data 文件夹，user_id.csv 位于其中，那么 user_id.csv 的引用描述如下：</p>
<pre><code>config:
    name: &quot;demo&quot;

testcases:
    testcase1_name:
        testcase: /path/to/testcase1
        parameters:
            user_id: ${P(data/user_id.csv)}
</code></pre>
<p>即 <code>P</code> 函数的参数（CSV 文件路径）是相对于项目根目录的相对路径。当然，这里也可以使用 CSV 文件在系统中的绝对路径，不过这样的话在项目路径变动时就会出现问题，因此推荐使用相对路径的形式。</p>
<h3 id="csv_1">关联参数 &amp; 引用 CSV 文件</h3>
<p>对于具有关联性的多个参数，例如 username 和 password，那么就可以创建 <a href="https://v2.httprunner.org/data/account.csv">account.csv</a>，并在文件中按照如下形式进行描述。</p>
<pre><code>username,password
test1,111111
test2,222222
test3,333333
</code></pre>
<p>然后在 YAML/JSON 测试用例文件中，就可以通过内置的 <code>parameterize</code>（可简写为 <code>P</code>）函数引用 CSV 文件。</p>
<p>假设项目的根目录下有 data 文件夹，account.csv 位于其中，那么 account.csv 的引用描述如下：</p>
<pre><code>config:
    name: &quot;demo&quot;

testcases:
    testcase1_name:
        testcase: /path/to/testcase1
        parameters:
            username-password: ${P(data/account.csv)}
</code></pre>
<p>需要说明的是，在 parameters 中指定的参数名称必须与 CSV 文件中第一行的参数名称一致，顺序可以不一致，参数个数也可以不一致。</p>
<p>例如，在 <a href="https://v2.httprunner.org/data/account.csv">account.csv</a> 文件中可以包含多个参数，username、password、phone、age：</p>
<pre><code>username,password,phone,age
test1,111111,18600000001,21
test2,222222,18600000002,22
test3,333333,18600000003,23
</code></pre>
<p>而在 YAML/JSON 测试用例文件中指定参数时，可以只使用部分参数，并且参数顺序无需与 CSV 文件中参数名称的顺序一致。</p>
<pre><code>config:
    name: &quot;demo&quot;

testcases:
    testcase1_name:
        testcase: /path/to/testcase1
        parameters:
            phone-username: ${P(account.csv)}
</code></pre>
<h3 id="_7">独立参数 &amp; 引用自定义函数</h3>
<p>对于没有现成参数列表，或者需要更灵活的方式动态生成参数的情况，可以通过在 debugtalk.py 中自定义函数生成参数列表，并在 YAML/JSON 引用自定义函数的方式。</p>
<p>例如，若需对 user_id 进行参数化数据驱动，参数取值范围为 1001～1004，那么就可以在 debugtalk.py 中定义一个函数，返回参数列表。</p>
<pre><code>def get_user_id():
    return [
        {&quot;user_id&quot;: 1001},
        {&quot;user_id&quot;: 1002},
        {&quot;user_id&quot;: 1003},
        {&quot;user_id&quot;: 1004}
    ]
</code></pre>
<p>然后，在 YAML/JSON 的 parameters 中就可以通过调用自定义函数的形式来指定数据源。</p>
<pre><code>config:
    name: &quot;demo&quot;

testcases:
    testcase1_name:
        testcase: /path/to/testcase1
        parameters:
            user_id: ${get_user_id()}
</code></pre>
<p>另外，通过函数的传参机制，还可以实现更灵活的参数生成功能，在调用函数时指定需要生成的参数个数。</p>
<h3 id="_8">关联参数 &amp; 引用自定义函数</h3>
<p>对于具有关联性的多个参数，实现方式也类似。</p>
<p>例如，在 debugtalk.py 中定义函数 get_account，生成指定数量的账号密码参数列表。</p>
<pre><code>def get_account(num):
    accounts = []
    for index in range(1, num+1):
        accounts.append(
            {&quot;username&quot;: &quot;user%s&quot; % index, &quot;password&quot;: str(index) * 6},
        )

    return accounts
</code></pre>
<p>那么在 YAML/JSON 的 parameters 中就可以调用自定义函数生成指定数量的参数列表。</p>
<pre><code>config:
    name: &quot;demo&quot;

testcases:
    testcase1_name:
        testcase: /path/to/testcase1
        parameters:
            username-password: ${get_account(10)}
</code></pre>
<blockquote>
<p>需要注意的是，在自定义函数中，生成的参数列表必须为 <code>list of dict</code> 的数据结构，该设计主要是为了与 CSV 文件的处理机制保持一致。</p>
</blockquote>
<h2 id="_9">参数化运行</h2>
<p>完成以上参数定义和数据源准备工作之后，参数化运行与普通测试用例的运行完全一致。</p>
<p>采用 hrun 命令运行自动化测试：</p>
<pre><code>$ hrun tests/data/demo_parameters.yml
</code></pre>
<p>采用 locusts 命令运行性能测试：</p>
<pre><code>$ locusts -f tests/data/demo_parameters.yml
</code></pre>
<p>区别在于，自动化测试时遍历一遍后会终止执行，性能测试时每个并发用户都会循环遍历所有参数。</p>
<h2 id="_10">案例演示</h2>
<p>假设我们有一个获取 token 的<a href="https://v2.httprunner.org/data/demo-testcase-get-token.yml">测试用例</a>。</p>
<details style="box-sizing: inherit; margin: 1.5625em 0px; padding: 0px 0.6rem; overflow: visible; color: rgba(0, 0, 0, 0.87); font-size: 0.64rem; break-inside: avoid; background-color: var(--md-admonition-bg-color); border-left: 0.2rem solid rgb(68, 138, 255); border-radius: 0.1rem; box-shadow: rgba(0, 0, 0, 0.05) 0px 0.2rem 0.5rem, rgba(0, 0, 0, 0.1) 0px 0px 0.05rem; display: block; font-family: Roboto, -apple-system, BlinkMacSystemFont, Helvetica, Arial, sans-serif; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><summary style="box-sizing: inherit; position: relative; margin: 0px -0.6rem; padding: 0.4rem 1.8rem 0.4rem 2rem; font-weight: 700; background-color: rgba(68, 138, 255, 0.1); display: block; min-height: 1rem; border-top-right-radius: 0.1rem; cursor: pointer; border-bottom-right-radius: 0.1rem;">点击查看 YAML 测试用例</summary></details>

<p>如果我们需要使用 device_sn、app_version 和 os_platform 这三个参数来进行参数化数据驱动，那么就可以创建一个 <a href="https://v2.httprunner.org/data/demo-parameters-get-token.yml">testsuite</a>，并且进行参数化配置。</p>
<pre><code>config:
    name: get token with parameters

testcases:
    get token with $user_agent, $app_version, $os_platform:
        testcase: demo-testcase-get-token.yml
        parameters:
            user_agent: [&quot;iOS/10.1&quot;, &quot;iOS/10.2&quot;, &quot;iOS/10.3&quot;]
            app_version: ${P(app_version.csv)}
            os_platform: ${get_os_platform()}
</code></pre>
<p>其中，<code>user_agent</code> 使用了直接指定参数列表的形式。</p>
<p><a href="https://v2.httprunner.org/data/app_version.csv">app_version</a> 通过 CSV 文件进行参数配置，对应的文件内容为：</p>
<pre><code>app_version
2.8.5
2.8.6
</code></pre>
<p>os_platform 使用自定义函数的形式生成参数列表，对应的函数内容为：</p>
<pre><code>def get_os_platform():
    return [
        {&quot;os_platform&quot;: &quot;ios&quot;},
        {&quot;os_platform&quot;: &quot;android&quot;}
    ]
</code></pre>
<p>那么，经过笛卡尔积组合，应该总共有 <code>3*2*2=12</code> 种参数组合情况。</p>
                
              
              
                


              
            </article>
          </div>
        </div>
        
      </main>
      
        
<footer class="md-footer">
  
    <nav class="md-footer__inner md-grid" aria-label="Footer">
      
        
        <a href="../50-%E6%B5%8B%E8%AF%95%E7%94%A8%E4%BE%8B%E5%88%86%E5%B1%82/" class="md-footer__link md-footer__link--prev" aria-label="上一页: 测试用例分层" rel="prev">
          <div class="md-footer__button md-icon">
            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
          </div>
          <div class="md-footer__title">
            <div class="md-ellipsis">
              <span class="md-footer__direction">
                上一页
              </span>
              测试用例分层
            </div>
          </div>
        </a>
      
      
        
        <a href="../70-%E6%96%87%E4%BB%B6%E4%B8%8A%E4%BC%A0%E5%9C%BA%E6%99%AF/" class="md-footer__link md-footer__link--next" aria-label="下一页: 文件上传场景" rel="next">
          <div class="md-footer__title">
            <div class="md-ellipsis">
              <span class="md-footer__direction">
                下一页
              </span>
              文件上传场景
            </div>
          </div>
          <div class="md-footer__button md-icon">
            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
          </div>
        </a>
      
    </nav>
  
  <div class="md-footer-meta md-typeset">
    <div class="md-footer-meta__inner md-grid">
      <div class="md-footer-copyright">
        
        
          Made with
          <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
            Material for MkDocs
          </a>
        
        
      </div>
      
    </div>
  </div>
</footer>
      
    </div>
    <div class="md-dialog" data-md-component="dialog">
      <div class="md-dialog__inner md-typeset"></div>
    </div>
    <script id="__config" type="application/json">{"base": "../..", "features": [], "translations": {"clipboard.copy": "\u590d\u5236", "clipboard.copied": "\u5df2\u590d\u5236", "search.config.lang": "ja", "search.config.pipeline": "trimmer, stemmer", "search.config.separator": "[\\uff0c\\u3002]+", "search.placeholder": "\u641c\u7d22", "search.result.placeholder": "\u952e\u5165\u4ee5\u5f00\u59cb\u641c\u7d22", "search.result.none": "\u6ca1\u6709\u627e\u5230\u7b26\u5408\u6761\u4ef6\u7684\u7ed3\u679c", "search.result.one": "\u627e\u5230 1 \u4e2a\u7b26\u5408\u6761\u4ef6\u7684\u7ed3\u679c", "search.result.other": "# \u4e2a\u7b26\u5408\u6761\u4ef6\u7684\u7ed3\u679c", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../../assets/javascripts/workers/search.fcfe8b6d.min.js", "version": null}</script>
    
    
      <script src="../../assets/javascripts/bundle.b1047164.min.js"></script>
      
    
  </body>
</html>